home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d3 / vde131.arc / VINST131.DOC < prev    next >
Text File  |  1989-07-20  |  23KB  |  436 lines
  1.  
  2.  
  3.  
  4.                                  VINST131.DOC
  5.                                  ------------ 
  6.                            [Supplement to VDE.DOC]
  7.  
  8.                     Instructions for VINSTALL 1.31 (03/89)
  9.                 Installation Utility for Video Display Editor
  10.                                 MSDOS Version
  11.  
  12.                                (c)1989 E. Meyer
  13.  
  14.  
  15.      VINSTALL is a utility that lets you customize your copy of the VDE 
  16. editor.  Most of this involves options that you need not concern yourself with 
  17. at first: in the course of using VDE, you will discover how you want these 
  18. things set.  However, there are important changes you will need to make to VDE 
  19. before using it, if you have a computer that:
  20.               * Is not fully IBM compatible (BIOS, video).
  21.               * Experiences "snow" problems with programs that write
  22.                  directly to video memory (older style CGA adapters).
  23.  
  24.      An uninstalled copy of VDE will ask you whether it is running on an IBM 
  25. compatible computer.  Once you have used VINSTALL this message will disappear.
  26.  
  27.      Note: VINSTALL modifies the file VDE.COM.  Always keep an unmodified 
  28. original copy of all VDE files in case problems arise.
  29.  
  30.  
  31. =================================  CONTENTS  =================================
  32.  
  33.  
  34. 1. RUNNING VINSTALL.  How to use VINST.COM to modify VDE.COM.
  35.  
  36. 2. INSTALLATION.  Installing for different computer hardware:
  37.    ============   Screen size; IBM compatibility; Colors; Fonts; Snow.
  38.  
  39. 3. USER OPTIONS.  Customization of many initial VDE settings.
  40.  
  41. 4. PRINTER INSTALLATION.  Using special printer features:
  42.                           print modes, graphics, etc.
  43.  
  44. 5. MACRO KEYS.  Installing a default set of macro keys.
  45.  
  46. 6. FUNCTION KEYS.  Installing the function keys.
  47.  
  48. 7. GRAPHICS.  Modifying the default set of graphics characters.
  49.  
  50. 8. RESTORE DEFAULTS.  Undoing previous modifications.
  51.  
  52.  
  53. ===========================  1. RUNNING VINSTALL  ============================
  54.  
  55.  
  56.      Your copies of the program files will have names like VINST13.COM and 
  57. VDE13.COM.  Feel free to rename these to VINSTALL and VDE, as will be assumed 
  58. here.  When you run VINSTALL you must give it the name of a copy of VDE to 
  59. modify:
  60.                               A>vinstall vde.com
  61.  
  62.      VINSTALL is fully menu-driven; it will present you with a set of 
  63. categories that corresponds to each section below, starting with Installation; 
  64. you select the values you want to change.
  65.      Note: the version numbers of VINSTALL and VDE (and any auxiliary key or 
  66. printer files, see below) must agree, or you will get an error.
  67.  
  68.      VINSTALL is largely self-documenting, and steps you through each item 
  69. individually.  If this is your first time running the program, take advantage 
  70. of its "Help" option before you start in, for some basic instructions.  You 
  71. may also find a good ASCII chart helpful.  VINSTALL uses several different 
  72. types of data entry:
  73.      TEXT - Just type in the character(s).
  74.      LOGICAL - Yes/No.  Just type "Y" or "N".
  75.      DECIMAL - Enter a number from 0 to 255.
  76.      HEX - Enter a two-digit hex byte value 00-FF.  (Don't omit lead zeros.)
  77.      BYTE STRINGS - fixed length: enter the required number of hex bytes.
  78.                     variable: enter the (hex) count for the number of bytes, 
  79.               followed by the bytes themselves.  Example:  (02)1B3D.  The max- 
  80.               imum length is given in square brackets [#].  This format is 
  81.               referred to below as "(#),bytes".
  82. VINSTALL can't check for illegal values; be careful what you enter!
  83.  
  84.      At most points in VINSTALL, you can press Esc to return immediately to 
  85. the Main Menu, or ^C to abort the program.
  86.  
  87.      What follows is a more detailed explanation of installation items, in 
  88. about the same order as in the VINSTALL procedure.
  89.  
  90.  
  91. =============================  2. INSTALLATION  ==============================
  92.  
  93.  
  94.      When you run VINSTALL on an uninstalled copy of VDE, this selection will 
  95. be made automatically.  You must describe the computer you are using: 
  96. basically, whether 100% IBM PC compatible, or not.  (The HP Portable Plus 
  97. laptop is also supported.)
  98.      The IBM PC installation gives the best performance, but requires an IBM 
  99. standard BIOS and a supported video adapter (MDA,CGA,EGA,VGA).  You can 
  100. customize the display (colors, fonts etc) to your preferences.
  101.      The non-IBM installation will run on any system that supports ANSI 
  102. standard screen control sequences (eg, the ANSI.SYS screen driver -- you must 
  103. have DEVICE=ANSI.SYS in your CONFIG.SYS file).  You must also specify the size 
  104. of your screen.  This installation can also be used on IBM compatibles, in the 
  105. event that direct video access is undesirable.
  106.  
  107. COMMON PARAMETERS:
  108.  
  109. Clock speed in MHz - Set this decimal value to reflect your CPU clock speed. 
  110.     Common values are 5 (for 4.77), 8, 10, 12, etc.  Adjust the value if 
  111.     desired to change the length of delays in VDE.  (You may need to increase 
  112.     this value for faster 80x86 computers.)
  113.  
  114. IBM PC PARAMETERS:
  115.  
  116. Screen colors - you can select five video attribute bytes: one for normal 
  117.     text; one for block text; one for soft CR markers; one for the header and 
  118.     menus; and one for highlights (prompts, etc). Each is two hex digits, for 
  119.     a background and foreground color.  You will see a color palette displayed 
  120.     on screen; the color digits are:
  121.            *0 = BLACK   4 = red      *8 = GREY        C = brt red
  122.             1 = blue    5 = magenta   9 = brt blue    D = brt magenta
  123.             2 = green   6 = brown     A = brt green   E = yellow
  124.             3 = cyan   *7 = WHITE     B = brt cyan   *F = BRT WHITE
  125.     (*-Only 0,7,8,F work on monochrome systems.)
  126.          Any digit may be used for the the foreground, but only 0-7 for 
  127.     background (8-F produce blinking video...  ugh).  You will probably want 
  128.     the header and highlight attributes to have the same background.  The 
  129.     defaults are:   07 (white text on black) for normal video;
  130.                     0F (bright on black) for blocks;
  131.                     08 (grey on black) for soft markers;
  132.                     70 (black on white) for header;
  133.                     78 (grey on white) for highlights.
  134.  
  135. Use VDE font in EGA mode (Y/N) - When the Alt-E command is used to display 43 
  136.     lines on an EGA (or 50 on VGA), you can choose one of two fonts.  VDE's 
  137.     own font is thinner than the ROM font, and you may find it more readable.  
  138.     "Y" selects this font; "N" selects the standard (fat) ROM font.
  139. Snow removal (Y/N) - Usually No; try this first.  Some older CGA systems 
  140.     experience ugly "snow" when programs write directly to video memory.  If 
  141.     this happens to you, set this option to "Y", and VDE will time its video 
  142.     access according to horizontal retrace intervals.  (Display speed will be 
  143.     slightly reduced.)
  144.  
  145. NON-IBM PC PARAMETERS: (automatically set for IBM PC)
  146.  
  147. Terminal init - enter an optional string of code (#),bytes to be sent to the 
  148.     screen after clearing the screen, whenever (re)entering VDE.
  149. Terminal uninit - enter an optional string of code (#),bytes to be sent to the 
  150.     screen upon exiting from VDE back to DOS.
  151.  
  152. Viewable columns (80-255) - normally 80; set to the column width of your 
  153.     display, if different.
  154. Viewable lines (16-255) - normally 25; if you have a shorter or longer default 
  155.     display (on entry to VDE), enter the length here.
  156. Enable fast scroll (Y/N) - Does your computer respond to the ANSI sequences 
  157.     for insert/delete line (Esc-[-L,M)?  If so, set this to "Y" for a faster 
  158.     display.  (Default is "N", as MSDOS ANSI.SYS does not support these codes; 
  159.     there are enhanced console drivers, such as NANSI.SYS, which do.  VDE will 
  160.     not work properly if you select "Y" when your console driver does not 
  161.     support these codes.)
  162. Horizontal scroll delay (01-FF) - This hex parameter creates a delay between 
  163.     scrolling the cursor line and the rest of the screen, when the screen 
  164.     shifts horizontally (past column 80).  A moderate delay is useful if your 
  165.     screen display is slow, as it minimizes interference with typing.  The 
  166.     default value is 40; you can adjust this to suit your taste.  (01=minimal; 
  167.     FF=very long, almost suppressing full redisplay.)
  168.  
  169.  
  170. =============================  3. USER OPTIONS  ===============================
  171.  
  172.  
  173.      You can select or change a variety of default settings in your copy of 
  174. VDE, according to your taste.  "Default" means the state assumed when VDE is 
  175. first run, or in the absence of any user commands.
  176.  
  177. Default buffer size in K (16-64) - Normally 64K.  If you have limited memory 
  178.     and/or usually work with small files, you may want to decrease this size.  
  179.     Do NOT use a value outside the range of 16 to 64K!
  180.  
  181. Create BAKup files (Y/N) - Should a backup file be made when you save over an 
  182.     existing file?  Choose "Y" to play safe, "N" to save disk space.
  183. Mark end of file (Y/N) - Should an EOF marker (^Z, 1Ah) be placed at the end 
  184.     of a file when writing to disk?  Most software won't care; some early 
  185.     MSDOS software may require this.  Originally No.
  186. Default file mode (W/A/N) -  Which of the three file modes "W","A","N" 
  187.     described in VDE.DOC do you want as the default?  (Originally "A".)
  188. Auto mode select filetypes - You can specify four filetypes (or type masks, 
  189.     using "?" wildcards) as exceptions to the above default: for example, you 
  190.     could declare all ".ASM" files to be automatically "N" mode, or all files 
  191.     ".?88" to be "W" mode.  Any mode option ("/N") explicitly specified still 
  192.     overrides this.
  193.  
  194. Default insert on (Y/N) - Do you want the INSERT toggle to start out ON when 
  195.     first entering VDE?  (Originally No.)
  196. Default ruler on (Y/N) - Do you want the Ruler line (^OT) to start out ON when 
  197.     first entering VDE?  (Originally No.)
  198. Default HCR display on (Y/N) - Do you want Hard CR display (^OB) to start out 
  199.     ON when entering a Document ("W/A" modes) with VDE?  (Originally Yes.)  
  200.     The default is always OFF in "N" mode.
  201. Default hyphenation on (Y/N) - Do you want hyphenation (^OH) to start out ON 
  202.     when first entering VDE?  (Originally Yes.)
  203. Default case-insensitive search (Y/N) - Do you want string searches (^QF) to 
  204.     be case insensitive by default?  (Originally No.)  If yes, the "U"ppercase 
  205.     option will force a case sensitive search.
  206.  
  207. Left and Right margin columns (1-255) - Default margin settings for "W/A" 
  208.     modes.  Set both to 1 to entirely disable wordwrap and reformatting.
  209. Default header off (Y/N) - Do you want the header display (^OQ) to start out 
  210.     OFF when first entering VDE?  (Originally No.)
  211. Scroll overlap (0-255) - This is the number of lines overlap between screens 
  212.     when scrolling with ^R/^C.  The smaller, the larger the scroll.  
  213.     Originally set to 2, for a nearly full scroll.  Keep this smaller than 
  214.     your screen size!
  215.  
  216. Ring bell on error (Y/N) - Do you want the bell to ring when a VDE error 
  217.     message displays?  (Originally No.)
  218. BS (^H) deletes to left (Y/N) - Do you want the Backspace (^H) key to delete 
  219.     characters?  Originally No - it just moves the cursor left nondestruc- 
  220.     tively, as in WordStar.
  221. DEL deletes to right (Y/N) - Do you want the Delete key to remove the charac- 
  222.     ter to the right?  Originally No - it deletes to the left, as in WordStar.
  223. Home,End move left/right on line (Y/N) - Do you want the Home and End keys to 
  224.     move to the start or end of the line?  Originally No -- they move to the 
  225.     top or bottom of the screen, as in WordStar 4.
  226.  
  227. Variable tab stops -  Enter up to 8 variable tab stop columns, in ascending 
  228.     order.  Fill unused values with 0.  Defaults: 6, 15, 35, 55.  (Note: hard 
  229.     tabs are set at intervals of 8 columns, and cannot be adjusted.)
  230.  
  231. Show time as AM/PM (Y/N) - Do you want the Time stamp to display in 12 hour 
  232.     format (eg 1:21 PM)?  Originally Yes.  If No, the time shows in 24 hour 
  233.     format (eg 13:21).
  234. Show European date (day,month) (Y/N) - Do you want the Date stamp to display 
  235.     in European format (eg 15.1.88 or 15 January 1988)?  Originally No, 
  236.     meaning US Format (eg 1/15/88 or January 15, 1988).
  237. Show date numerically (Y/N) - Do you want the Date stamp to display 
  238.     numerically (eg 1/15/88)?  Originally No, meaning verbose (eg January 15, 
  239.     1988).
  240.  
  241.  
  242. =========================  4. PRINTER INSTALLATION  ==========================
  243.  
  244.  
  245.      Printers vary enormously.  VDE can accomodate two printer drivers, each 
  246. of which can be installed to take advantage of your printer's special 
  247. features.  (Within VDE, the Alt-P command can be used to select the driver to 
  248. use when printing.)  By default each is a "Simple" driver which can send plain 
  249. text, but does not support underlining or any other print controls.  A basic 
  250. driver for an IBM/Epson FX compatible dot matrix printer can also be selected 
  251. directly from the VINSTALL menu.  This driver implements the print toggles and 
  252. switches according to their usual WordStar purposes (see below).
  253.      VINSTALL can use special Printer Installation files to store and retrieve 
  254. other printer definitions.  These should have a file type of ".VDP".  You have 
  255. the option to read in or write out such a file, as well as editing the 
  256. following values individually.  This makes it easy to pass your installation 
  257. along to others.
  258.      NOTE: in order to modify the Alternate printer driver, you must temporar- 
  259. ily make it the selected driver.  The Read/Write/Edit modes affect only the 
  260. selected driver.
  261.  
  262. Printer ID - Identify the printer you are installing.  (16 characters)
  263.  
  264. IBM graphics printer (Y/N) - Normally No; if you can print the IBM extended 
  265.     ASCII characters, set this to Yes.  If No, VDE will "emulate" graphics on 
  266.     printing, choosing standard character combinations that come close.  (Try 
  267.     this out; it's very useful.)
  268. Send LF after CR (Y/N) - Normally Yes.  But with some printers, which manufac- 
  269.     ture their own LF on receiving a CR, you will want No here.
  270.  
  271. Page length (0-255) - Set the number of text lines to print on a page.  (Does 
  272.     not include another 3 lines for a header, if used.)   Setting to 0 
  273.     disables pagination.
  274. Top margin (0-255) - Set the number of blank lines to skip as a top margin 
  275.     before printing each page.  This value (not included in the page length) 
  276.     can be used to position the paper properly.  Default is 0.
  277. Reserve space for header (Y/N) - Default is Yes; when printing without a 
  278.     header, 3 blank lines will be left at the top of each page, so that the 
  279.     physical page layout is the same.  If set to No, those lines will be 
  280.     filled with 3 extra lines of text per page.
  281. Left margin (0-255) - Set the number of blank columns to skip as a left margin 
  282.     before printing each line.  Useful if you can't set the margin on your 
  283.     printer with an initialization string.  Default is 0.
  284.  
  285. Printer initialization - Enter an optional string of code (#),bytes to send to 
  286.     the printer before each print job, to set default margins, print modes etc.
  287. Printer uninit - Enter another optional string (#),bytes to send to the 
  288.     printer after each print job, to restore printer to desired state on exit.
  289.  
  290. Codes for toggles (on/off) - For each of the six printer toggles, you need to 
  291.     tell VDE the codes to send to your printer to produce the desired effect, 
  292.     then turn it off again.  The conventional meanings of the toggles are:
  293.          ^B  boldface         ^S  underline          ^T  superscript
  294.          ^D  doublestrike     ^Y  ribbon/italic      ^V  subscript
  295.     but you can use them for anything you want.  Example: Your printer 
  296.     requires the codes ESC-U-01 to turn underlining on, and ESC-U-00 to turn 
  297.     it off.  You would enter (starting with the byte count):
  298.               ^S toggle on [07]:  (03)1B5501
  299.                     and off [07]:  (03)1B5500
  300.     You should find the necessary ASCII hex codes in your printer manual.
  301. Codes for switches - The same idea, but for switches, which send the same 
  302.     codes every time they are used.  WordStar calls the switches:
  303.           ^Q,^W,^E,^R  user1...4       ^A,^N  alternate, normal pitch
  304.     but you can use them for anything you want.
  305.  
  306.  
  307. ==============================  5. MACRO KEYS  ===============================
  308.  
  309.  
  310.      The default macro definitions are those attached to the commands Esc-0..Z 
  311. when VDE is first entered.  By changing them you can configure VDE to suit 
  312. your own specialized writing requirements.  (Any Keys defined with Esc] while 
  313. using VDE override the defaults.)
  314.      VINSTALL can use Key Definition files to store macro key sets.  These 
  315. should have a file type of ".VDK", for ease of identification.  You have the 
  316. option to read in or write out such a file, as well as editing the keys 
  317. individually.  (VDK files can also be read in with VDE's Alt-U command.)
  318.      VINSTALL gives you a display much like this:
  319.  
  320.       Macro Keys:  (___ bytes free)      <---- note room (up to 982)
  321.       [Esc0]<>
  322.       [Esc1]<>                           <---- "<>" flag means empty
  323.       [Esc2]<>
  324.       [Esc3]^[;^C                        <---- normal macro key
  325.       [Esc4]<>
  326.       [Esc5]<N>World Wide Widgets Inc.   <---- "<N>" flag means no-rpt key
  327.       [Esc6]<>
  328.       [Esc7]<Q>^QR^KB^QC^KK^KC           <---- "<Q>" flag means quiet key
  329.       [Esc8]<>
  330.       [Esc9]<>
  331.  
  332. This is pretty straightforward; you just select the number of the Key you wish 
  333. to redefine, then type in the new definition, much as you would in VDE.  All 
  334. the same rules apply (but VINSTALL will accept longer keys, up to 128 bytes).  
  335. If the new definition is too long to fit it will be rejected.
  336.      There are several different ranges of keys, which can be displayed and 
  337. modified in a range of 10 at a time (for example, keys 0-9, or A-J).
  338.      VDE.ARC comes with a macro key file EXAMPLES.VDK, containing these
  339. example macros taken from VDE.DOC:
  340.  
  341.      [Esc1]<Q>^QR^NAltD^OF
  342.      [Esc2]<Q>^[~.1^S^[1^[~.<^[2^D^[= 2^[=^M2
  343.      [Esc3]<Q>^QS^X^[=^M]^S^V ^V^D^[![
  344.      [Esc4]<Q>^S^[~ 2^[1^G^S^[= 1^[2^G^S^[~ 2^D
  345.  
  346. These are: Put date at top right of file; Move to start of current sentence; 
  347. Soften a hard-CR paragraph; Delete word left.  (Note "Esc" displays "^[".)
  348.  
  349.  
  350. ============================  6. FUNCTION KEYS  ==============================
  351.  
  352.  
  353.      VDE also has a set of forty Function-keys, corresponding to the [F1]... 
  354. [F10] keys in their normal, Shift-, Ctrl-, and Alt- usage ([F1]...[F40]).  
  355. These are identical in features and functions to the MACRO keys discussed 
  356. above.  You can easily configure these to match the standard function-key 
  357. configuration for Wordstar's key overlay, to correspond to Word Perfect 
  358. function-key usage, or in any other way you like.
  359.      VINSTALL can use Function-key Definition files to store function key 
  360. sets.  These should have a file type of ".VDF", for ease of identification.  
  361. You have the option to read in or write out such a file, as well as editing 
  362. the keys individually.  (VDF files can also be read in with VDE's Alt-U 
  363. command.)
  364.      VINSTALL gives you a display much like this:
  365.  
  366.       Function keys 1-10:  (___ bytes free)   <---- note room (up to 982)
  367.       [F1]<>
  368.       [F2]<>                                  <---- "<>" flag means empty
  369.       [F3]<>
  370.       [F4]<Q>^OL5^M^OR60^M                    <---- normal function key
  371.       [F5]<>
  372.       [F6]<>
  373.       [F7]<>
  374.       [F8]<>
  375.       [F9]<Q>^PS
  376.       [F0]<Q>^PY
  377.  
  378. This works just like the macro keys above, except there are four sets of 10 
  379. keys to define (<N>ormal, <S>hift, <C>trl, <A>lt).
  380.      VDE.ARC includes a sample file WS4.VDF, which you can read in to define 
  381. the function keys according to the WordStar 4 default usage:
  382.  
  383.              NORMAL      SHIFT        CTRL             ALT
  384.      [F1]     ^J          ^OB          ^QF         Vertical bar graphic
  385.      [F2]     ^U          ^OC          ^QA         Horizontal bar
  386.      [F3]     ^PS                      ^L          Upper-left corner
  387.      [F4]     ^PB                      ^QI         Upper-right corner
  388.      [F5]     ^Y          ^KY          ^OL         Lower-left corner
  389.      [F6]     ^T          ^KU          ^OR         Lower-right corner
  390.      [F7]                 ^KV                      Upper T graphic
  391.      [F8]                 ^KC                      Lower T
  392.      [F9]     ^KS         ^KB          ^QS         Left T
  393.      [F10]    ^KD         ^KK          ^QD         Right T
  394.  
  395.  
  396. ==========================  7. GRAPHICS CHARACTERS  ==========================
  397.  
  398.  
  399.      VDE's handling of graphics assumes an IBM compatible PC.  However, it may 
  400. work usefully for other MSDOS computers, if your video system supports a set 
  401. of extra characters for ASCII codes with the high bit set.
  402.      VDE allows text to contain a limited (but variable) set of 32 IBM 
  403. graphics characters, restricted to the ASCII range 80-FE.  (These are entered 
  404. with the Alt-G command in VDE.)  The default set includes box pieces and other 
  405. useful things, and has some room free, but you can change it to include 
  406. whatever you need.  The important thing to remember is that these are the only 
  407. graphics codes that VDE can manage: if you load a file containing graphics not 
  408. in this set, unless there is room to add them, they will turn into grey blobs 
  409. (graphic #6)!  So don't feel obliged to fill your set completely.
  410.      You will be shown the current definitions, in the same format as the VDE 
  411. Alt-G command.  You can pick any one (A-Z, 1-5) to change, or type "-" to 
  412. clear them all.  (Graphic 6 cannot be changed; it always remains a grey blob.) 
  413. New graphic codes are entered by hex value, from 80 to FE; a full list of 
  414. graphics characters can be displayed for your selection if you need it, by 
  415. typing "?".  An entry of FF is considered "open", and can be used on loading a 
  416. file to accomodate any extra characters needed.
  417.      Note that your Printer Installation determines how graphics will print.
  418.  
  419.  
  420.  
  421. ===========================  8. RESTORE DEFAULTS  ============================
  422.  
  423.  
  424.      This option on the VINSTALL menu is provided in the event that you want 
  425. to undo any changes that you (or someone else) has made to your copy of VDE.  
  426. This should return VDE to the state it was distributed in: installation for 
  427. IBM PC, all User Options restored to their defaults, printer set to a basic 
  428. Teletype, no Macro or Function Keys, original Graphics characters.
  429.  
  430.  
  431.  
  432.  
  433.          ---  Eric Meyer, 401 12th Ave SE #139, Norman OK 73071  ---
  434.  
  435. ==============================================================================
  436.